🚩 YAML frontmatter compatibility with SPDX headers

The .claude/skills/*/SKILL.md files use YAML frontmatter (--- delimiters) as their first content. When adding the SPDX HTML comment header before the frontmatter, some strict markdown/YAML parsers may not recognize the frontmatter if it's not at byte 0 of the file. However, Claude Code's SKILL.md parser (and most modern tools like GitHub, Hugo, Jekyll) handle HTML comments before frontmatter without issue. If a compatibility issue arises with skills.sh tooling, the SPDX header could alternatively be placed inside the frontmatter block as a YAML comment, though the HTML comment approach is consistent with every other .md file in this repo.

Was this helpful? React with 👍 or 👎 to provide feedback.

There's more under samples/ worth documenting as it serves all of our assets (e.g. audio files, images, fonts, slint files, and likely more in the future).

Good point — updated to samples/ (not samples/pipelines/) and expanded the description to include audio files, images, fonts, and Slint files. Fixed in 9a2db12.

worth mentioning we have another level of non-UI e2e tests, under tests/, which are essentially oneshot pipeline validations atm.

I looked for a top-level tests/ directory but it doesn't exist yet on main (only e2e/tests/). Could you clarify where these oneshot pipeline validation tests live? Happy to add the entry once I know the path — or if this is something planned, I can add it when it lands.

PR is not up to date with main, you should merge.

Merged main into the branch. However, tests/ still doesn't exist at the repo root after the merge — only e2e/tests/. Is it on a different branch, or something planned? Happy to add the codebase map entry once it lands.

Apologies, these are getting introduced in #279, but still makes sense to assume they are in so we don't forget later as we'll merge both soon.

Thanks for clarifying — added tests/ to both codebase maps (AGENTS.md and architecture.md) as "Pipeline validation tests (oneshot pipeline smoke tests)". Fixed in 58087fd.

How do we keep this maintainable? For example, we might upgrade to v1.94 tomorrow.

Fair concern — removed the hardcoded version. Now reads **Rust** (version pinned in \rust-toolchain.toml`)` so it stays accurate across upgrades. Fixed in 9a2db12.

nit: we do have full versions that do.

Updated to distinguish slim vs full images: "Slim images do not bundle ML models or plugins — mount them at runtime. Full images (with -full tag) include bundled models and plugins." Fixed in 9a2db12.

Also, if a plugin relies on models, we want to upload them to our streamkit Huggingface repo so they're accessible indefinitely, license permitting. But if the license is that restrictive, we probably shouldn't build a plugin with it anyway.

Good addition — added a bullet point: "Models: if the plugin relies on ML models, upload them to the StreamKit Hugging Face repo so they remain accessible indefinitely (license permitting)." Fixed in 9a2db12.

🟡 AGENTS.md incorrectly claims just lint-skit includes a license check

The Verification Commands table states just lint-skit performs "fmt + clippy with per-crate feature flags + license check", but the actual lint-skit recipe in the justfile only runs cargo fmt and cargo clippy. The license check is performed by the separate check-license-headers recipe, which is invoked by just lint but not by just lint-skit. An agent that runs only just lint-skit (believing it covers license compliance) would miss the SPDX/REUSE check entirely.

Was this helpful? React with 👍 or 👎 to provide feedback.

This finding is incorrect — lint-skit does include a license check. Line 235 of the justfile runs cargo deny check licenses as part of the lint-skit recipe. The description "fmt + clippy with per-crate feature flags + license check" is accurate.

🚩 Legacy Dockerfile.full and Dockerfile.full-gpu still exist alongside new Dockerfile.demo

The Docker section now references only Dockerfile.demo (tagged -demo), which matches the current .github/workflows/docker.yml. However, the repo still contains Dockerfile.full and Dockerfile.full-gpu files. These appear to be legacy files not referenced by any workflow. While the new documentation is accurate about the active Docker setup, the presence of these stale Dockerfiles could confuse contributors who browse the repo root. Consider removing them or adding a note.

Was this helpful? React with 👍 or 👎 to provide feedback.

Acknowledged — the documentation now accurately describes the active Docker workflow (Dockerfile, Dockerfile.gpu, Dockerfile.demo). The stale Dockerfile.full / Dockerfile.full-gpu files are a pre-existing cleanup item outside the scope of this docs PR. @streamer45 — want me to file a separate issue to track removing those?

streamkit:full-gpu is actually used as base for our private demo deployment so I'd leave as is.

Got it — Dockerfile.full-gpu is in active use for the private demo deployment. No cleanup needed then. The docs are accurate as-is for the public workflow.

🚩 Codebase map references tests/ directory that doesn't exist yet

Both AGENTS.md:36 and agent_docs/architecture.md:37 document a tests/ directory for "Pipeline validation tests (oneshot pipeline smoke tests)". This directory does not exist on origin/main or in the current working tree. It was introduced in commit 70347b9 (PR #285: "feat(e2e): add headless pipeline validation tests") which is not yet merged into main. If this PR merges before #285, the documentation will reference a non-existent directory. Not flagged as a bug because it's common for doc PRs to anticipate parallel changes, and the impact is limited to documentation accuracy.

Was this helpful? React with 👍 or 👎 to provide feedback.

Intentional — the maintainer explicitly requested adding tests/ to anticipate the parallel PR landing soon.